Skip to content

fix: Update README with new k3d cluster creation command to work with…#73

Merged
venkatamutyala merged 1 commit into
mainfrom
venkatamutyala-patch-1
Apr 26, 2026
Merged

fix: Update README with new k3d cluster creation command to work with…#73
venkatamutyala merged 1 commit into
mainfrom
venkatamutyala-patch-1

Conversation

@venkatamutyala

Copy link
Copy Markdown
Contributor

… lower MTU networks

Copilot AI review requested due to automatic review settings April 26, 2026 19:53
@venkatamutyala venkatamutyala merged commit faa12a9 into main Apr 26, 2026
4 checks passed
@venkatamutyala venkatamutyala deleted the venkatamutyala-patch-1 branch April 26, 2026 19:53

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the README’s k3d cluster bootstrap command to pre-create a dedicated Docker bridge network with a lower MTU, improving reliability in lower-MTU environments.

Changes:

  • Adds deletion/recreation of a k3d-glueops-net Docker network before creating the cluster
  • Sets the Docker network MTU to 1400 via com.docker.network.driver.mtu

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
Run:
```bash
k3d cluster delete captain || true && curl https://raw.githubusercontent.com/GlueOps/k3d/main/k3d-config.yaml -o k3d-config.yaml && k3d cluster create --config k3d-config.yaml && bash <(curl -sL https://raw.githubusercontent.com/GlueOps/k3d/main/add-machineid.sh)
k3d cluster delete captain || true && docker network rm k3d-glueops-net || true && docker network create --driver bridge --opt com.docker.network.driver.mtu=1400 k3d-glueops-net && curl https://raw.githubusercontent.com/GlueOps/k3d/main/k3d-config.yaml -o k3d-config.yaml && k3d cluster create --config k3d-config.yaml && bash <(curl -sL https://raw.githubusercontent.com/GlueOps/k3d/main/add-machineid.sh)

Copilot AI Apr 26, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This single-line command is getting quite long and hard to troubleshoot when one step fails. Splitting it across multiple lines (continuations) or separating into a small script section in the README would improve readability and make failures easier for users to pinpoint.

Suggested change
k3d cluster delete captain || true && docker network rm k3d-glueops-net || true && docker network create --driver bridge --opt com.docker.network.driver.mtu=1400 k3d-glueops-net && curl https://raw.githubusercontent.com/GlueOps/k3d/main/k3d-config.yaml -o k3d-config.yaml && k3d cluster create --config k3d-config.yaml && bash <(curl -sL https://raw.githubusercontent.com/GlueOps/k3d/main/add-machineid.sh)
k3d cluster delete captain || true && \
docker network rm k3d-glueops-net || true && \
docker network create --driver bridge --opt com.docker.network.driver.mtu=1400 k3d-glueops-net && \
curl https://raw.githubusercontent.com/GlueOps/k3d/main/k3d-config.yaml -o k3d-config.yaml && \
k3d cluster create --config k3d-config.yaml && \
bash <(curl -sL https://raw.githubusercontent.com/GlueOps/k3d/main/add-machineid.sh)

Copilot uses AI. Check for mistakes.
Comment thread README.md
Run:
```bash
k3d cluster delete captain || true && curl https://raw.githubusercontent.com/GlueOps/k3d/main/k3d-config.yaml -o k3d-config.yaml && k3d cluster create --config k3d-config.yaml && bash <(curl -sL https://raw.githubusercontent.com/GlueOps/k3d/main/add-machineid.sh)
k3d cluster delete captain || true && docker network rm k3d-glueops-net || true && docker network create --driver bridge --opt com.docker.network.driver.mtu=1400 k3d-glueops-net && curl https://raw.githubusercontent.com/GlueOps/k3d/main/k3d-config.yaml -o k3d-config.yaml && k3d cluster create --config k3d-config.yaml && bash <(curl -sL https://raw.githubusercontent.com/GlueOps/k3d/main/add-machineid.sh)

Copilot AI Apr 26, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docker network rm ... || true can mask a failed removal (e.g., network still has active endpoints). In that case the subsequent docker network create ... k3d-glueops-net will fail because the network name already exists, stopping the whole chain. Consider either (1) making the create step tolerant of an existing network, or (2) explicitly detecting/remediating the “network in use” case and telling the user what to do (remove endpoints / pick a different network name) so the command is reliable.

Suggested change
k3d cluster delete captain || true && docker network rm k3d-glueops-net || true && docker network create --driver bridge --opt com.docker.network.driver.mtu=1400 k3d-glueops-net && curl https://raw.githubusercontent.com/GlueOps/k3d/main/k3d-config.yaml -o k3d-config.yaml && k3d cluster create --config k3d-config.yaml && bash <(curl -sL https://raw.githubusercontent.com/GlueOps/k3d/main/add-machineid.sh)
k3d cluster delete captain || true && docker network rm k3d-glueops-net || true && (docker network inspect k3d-glueops-net >/dev/null 2>&1 || docker network create --driver bridge --opt com.docker.network.driver.mtu=1400 k3d-glueops-net) && curl https://raw.githubusercontent.com/GlueOps/k3d/main/k3d-config.yaml -o k3d-config.yaml && k3d cluster create --config k3d-config.yaml && bash <(curl -sL https://raw.githubusercontent.com/GlueOps/k3d/main/add-machineid.sh)

Copilot uses AI. Check for mistakes.
Comment thread README.md
Run:
```bash
k3d cluster delete captain || true && curl https://raw.githubusercontent.com/GlueOps/k3d/main/k3d-config.yaml -o k3d-config.yaml && k3d cluster create --config k3d-config.yaml && bash <(curl -sL https://raw.githubusercontent.com/GlueOps/k3d/main/add-machineid.sh)
k3d cluster delete captain || true && docker network rm k3d-glueops-net || true && docker network create --driver bridge --opt com.docker.network.driver.mtu=1400 k3d-glueops-net && curl https://raw.githubusercontent.com/GlueOps/k3d/main/k3d-config.yaml -o k3d-config.yaml && k3d cluster create --config k3d-config.yaml && bash <(curl -sL https://raw.githubusercontent.com/GlueOps/k3d/main/add-machineid.sh)

Copilot AI Apr 26, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The curl https://... -o k3d-config.yaml download does not fail the command chain on HTTP errors (e.g., 404/500), which can lead to creating a cluster with an invalid/HTML config file. Using curl’s “fail on HTTP error” option (and keeping the rest of the pipeline unchanged) would make this setup command safer and easier to debug.

Suggested change
k3d cluster delete captain || true && docker network rm k3d-glueops-net || true && docker network create --driver bridge --opt com.docker.network.driver.mtu=1400 k3d-glueops-net && curl https://raw.githubusercontent.com/GlueOps/k3d/main/k3d-config.yaml -o k3d-config.yaml && k3d cluster create --config k3d-config.yaml && bash <(curl -sL https://raw.githubusercontent.com/GlueOps/k3d/main/add-machineid.sh)
k3d cluster delete captain || true && docker network rm k3d-glueops-net || true && docker network create --driver bridge --opt com.docker.network.driver.mtu=1400 k3d-glueops-net && curl -f https://raw.githubusercontent.com/GlueOps/k3d/main/k3d-config.yaml -o k3d-config.yaml && k3d cluster create --config k3d-config.yaml && bash <(curl -sL https://raw.githubusercontent.com/GlueOps/k3d/main/add-machineid.sh)

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants